<!DOCTYPE html>
<html lang="en">
<head>
	<meta charset="UTF-8">
	<meta http-equiv="X-UA-Compatible" content="IE=edge">
    <meta name="viewport" content="width=device-width, initial-scale=1">
	<title>cat recovery API | ElasticSearch 7.7 权威指南中文版</title>
	<meta name="keywords" content="ElasticSearch 权威指南中文版, elasticsearch 7, es7, 实时数据分析，实时数据检索" />
    <meta name="description" content="ElasticSearch 权威指南中文版, elasticsearch 7, es7, 实时数据分析，实时数据检索" />
    <!-- Give IE8 a fighting chance -->
    <!--[if lt IE 9]>
    <script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js"></script>
    <script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
    <![endif]-->
	<link rel="stylesheet" type="text/css" href="../static/styles.css" />
	<script>
	var _link = 'cat-recovery.html';
    </script>
</head>
<body>
<div class="main-container">
    <section id="content">
        <div class="content-wrapper">
            <section id="guide" lang="zh_cn">
                <div class="container">
                    <div class="row">
                        <div class="col-xs-12 col-sm-8 col-md-8 guide-section">
                            <div style="color:gray; word-break: break-all; font-size:12px;">原英文版地址: <a href="https://www.elastic.co/guide/en/elasticsearch/reference/7.7/cat-recovery.html" rel="nofollow" target="_blank">https://www.elastic.co/guide/en/elasticsearch/reference/7.7/cat-recovery.html</a>, 原文档版权归 www.elastic.co 所有<br/>本地英文版地址: <a href="../en/cat-recovery.html" rel="nofollow" target="_blank">../en/cat-recovery.html</a></div>
                        <!-- start body -->
                  <div class="page_header">
<strong>重要</strong>: 此版本不会发布额外的bug修复或文档更新。最新信息请参考 <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html" rel="nofollow">当前版本文档</a>。
</div>
<div id="content">
<div class="breadcrumbs">
<span class="breadcrumb-link"><a href="index.html">Elasticsearch Guide [7.7]</a></span>
»
<span class="breadcrumb-link"><a href="rest-apis.html">REST APIs</a></span>
»
<span class="breadcrumb-link"><a href="cat.html">cat APIs</a></span>
»
<span class="breadcrumb-node">cat recovery API</span>
</div>
<div class="navheader">
<span class="prev">
<a href="cat-plugins.html">« cat plugins API</a>
</span>
<span class="next">
<a href="cat-repositories.html">cat repositories API »</a>
</span>
</div>
<div class="section">
<div class="titlepage"><div><div>
<h2 class="title">
<a id="cat-recovery"></a>cat recovery API<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/cat/recovery.asciidoc">edit</a>
</h2>
</div></div></div>

<p>Returns information about ongoing and completed shard recoveries,
similar to the <a class="xref" href="indices-recovery.html" title="Index recovery API">index recovery</a> API.</p>
<div class="section">
<div class="titlepage"><div><div>
<h3 class="title">
<a id="cat-recovery-api-request"></a>Request<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/cat/recovery.asciidoc">edit</a>
</h3>
</div></div></div>
<p><code class="literal">GET /_cat/recovery/&lt;index&gt;</code></p>
<p><code class="literal">GET /_cat/recovery</code></p>
</div>

<div class="section">
<div class="titlepage"><div><div>
<h3 class="title">
<a id="cat-recovery-api-desc"></a>Description<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/cat/recovery.asciidoc">edit</a>
</h3>
</div></div></div>
<p>The cat recovery API returns information about shard recoveries, both
ongoing and completed. It is a more compact view of the JSON
<a class="xref" href="indices-recovery.html" title="Index recovery API">index recovery</a> API.</p>
<p>Shard recovery is the process
of syncing a replica shard from a primary shard.
Upon completion,
the replica shard is available for search.</p>
<p>Recovery automatically occurs
during the following processes:</p>
<div class="ulist itemizedlist">
<ul class="itemizedlist">
<li class="listitem">
Node startup or failure.
This type of recovery is called a <span class="strong strong"><strong>local store recovery</strong></span>.
</li>
<li class="listitem">
<a class="xref" href="glossary.html#glossary-replica-shard">Primary shard replication</a>.
</li>
<li class="listitem">
Relocation of a shard to a different node in the same cluster.
</li>
<li class="listitem">
<a href="snapshots-restore-snapshot.html" class="ulink" target="_top">Snapshot restoration</a>.
</li>
</ul>
</div>
</div>

<div class="section">
<div class="titlepage"><div><div>
<h3 class="title">
<a id="cat-recovery-path-params"></a>Path parameters<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/cat/recovery.asciidoc">edit</a>
</h3>
</div></div></div>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">&lt;index&gt;</code>
</span>
</dt>
<dd>
(Optional, string) Comma-separated list or wildcard expression of index names
used to limit the request.
</dd>
</dl>
</div>
</div>

<div class="section">
<div class="titlepage"><div><div>
<h3 class="title">
<a id="cat-recovery-query-params"></a>Query parameters<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/cat/recovery.asciidoc">edit</a>
</h3>
</div></div></div>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">active_only</code>
</span>
</dt>
<dd>
(Optional, boolean)
If <code class="literal">true</code>,
the response only includes ongoing shard recoveries.
Defaults to <code class="literal">false</code>.
</dd>
<dt>
<span class="term">
<code class="literal">bytes</code>
</span>
</dt>
<dd>
(Optional, <a class="xref" href="common-options.html#byte-units" title="Byte size units">byte size units</a>) Unit used to display byte values.
</dd>
<dt>
<span class="term">
<code class="literal">detailed</code>
</span>
</dt>
<dd>
(Optional, boolean)
If <code class="literal">true</code>,
the response includes detailed information about shard recoveries.
Defaults to <code class="literal">false</code>.
</dd>
<dt>
<span class="term">
<code class="literal">format</code>
</span>
</dt>
<dd>
(Optional, string) Short version of the
<a href="https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html" class="ulink" target="_top">HTTP accept header</a>.
Valid values include JSON, YAML, etc.
</dd>
<dt>
<span class="term">
<code class="literal">h</code>
</span>
</dt>
<dd>
(Optional, string) Comma-separated list of column names to display.
</dd>
<dt>
<span class="term">
<code class="literal">help</code>
</span>
</dt>
<dd>
(Optional, boolean) If <code class="literal">true</code>, the response includes help information. Defaults
to <code class="literal">false</code>.
</dd>
<dt>
<span class="term">
<code class="literal">index</code>
</span>
</dt>
<dd>
(Optional, string)
Comma-separated list or wildcard expression of index names
used to limit the request.
</dd>
<dt>
<span class="term">
<code class="literal">s</code>
</span>
</dt>
<dd>
(Optional, string) Comma-separated list of column names or column aliases used
to sort the response.
</dd>
<dt>
<span class="term">
<code class="literal">time</code>
</span>
</dt>
<dd>
(Optional, <a class="xref" href="common-options.html#time-units" title="Time units">time units</a>)
Unit used to display time values.
</dd>
<dt>
<span class="term">
<code class="literal">v</code>
</span>
</dt>
<dd>
(Optional, boolean) If <code class="literal">true</code>, the response includes column headings.
Defaults to <code class="literal">false</code>.
</dd>
</dl>
</div>
</div>

<div class="section">
<div class="titlepage"><div><div>
<h3 class="title">
<a id="cat-recovery-api-example"></a>Examples<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/cat/recovery.asciidoc">edit</a>
</h3>
</div></div></div>
<div class="section">
<div class="titlepage"><div><div>
<h4 class="title">
<a id="cat-recovery-api-ex-dead"></a>Example with no ongoing recoveries<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/cat/recovery.asciidoc">edit</a>
</h4>
</div></div></div>
<div class="pre_wrapper lang-console">
<pre class="programlisting prettyprint lang-console">GET _cat/recovery?v</pre>
</div>
<div class="console_widget" data-snippet="snippets/1368.console"></div>
<p>The API returns the following response:</p>
<div class="pre_wrapper lang-txt">
<pre class="programlisting prettyprint lang-txt">index   shard time type  stage source_host source_node target_host target_node repository snapshot files files_recovered files_percent files_total bytes bytes_recovered bytes_percent bytes_total translog_ops translog_ops_recovered translog_ops_percent
twitter 0     13ms store done  n/a         n/a         127.0.0.1   node-0      n/a        n/a      0     0               100%          13          0     0               100%          9928        0            0                      100.0%</pre>
</div>
<p>In this example response, the source and target nodes are the same because the
recovery type is <code class="literal">store</code>, meaning they were read from local storage on node
start.</p>
</div>

<div class="section">
<div class="titlepage"><div><div>
<h4 class="title">
<a id="cat-recovery-api-ex-live"></a>Example with a live shard recovery<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/cat/recovery.asciidoc">edit</a>
</h4>
</div></div></div>
<p>By increasing the replica count of an index and bringing another node online to
host the replicas, you can retrieve information about an ongoing recovery.</p>
<div class="pre_wrapper lang-console">
<pre class="programlisting prettyprint lang-console">GET _cat/recovery?v&amp;h=i,s,t,ty,st,shost,thost,f,fp,b,bp</pre>
</div>
<div class="console_widget" data-snippet="snippets/1369.console"></div>
<p>The API returns the following response:</p>
<div class="pre_wrapper lang-txt">
<pre class="programlisting prettyprint lang-txt">i       s t      ty   st    shost       thost       f     fp      b bp
twitter 0 1252ms peer done  192.168.1.1 192.168.1.2 0     100.0%  0 100.0%</pre>
</div>
<p>In this example response, the recovery type is <code class="literal">peer</code>, meaning the shard
recovered from another node. The returned files and bytes are real-time
measurements.</p>
</div>

<div class="section">
<div class="titlepage"><div><div>
<h4 class="title">
<a id="cat-recovery-api-ex-snapshot"></a>Example with a snapshot recovery<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/cat/recovery.asciidoc">edit</a>
</h4>
</div></div></div>
<p>You can restore backups of an index using the <a class="xref" href="modules-snapshots.html" title="Snapshot module">snapshot and
restore</a> API. You can use the cat recovery API retrieve information about a
snapshot recovery.</p>
<div class="pre_wrapper lang-console">
<pre class="programlisting prettyprint lang-console">GET _cat/recovery?v&amp;h=i,s,t,ty,st,rep,snap,f,fp,b,bp</pre>
</div>
<div class="console_widget" data-snippet="snippets/1370.console"></div>
<p>The API returns the following response with a recovery type of <code class="literal">snapshot</code>:</p>
<div class="pre_wrapper lang-txt">
<pre class="programlisting prettyprint lang-txt">i       s t      ty       st    rep     snap   f  fp   b     bp
twitter 0 1978ms snapshot done  twitter snap_1 79 8.0% 12086 9.0%</pre>
</div>
</div>

</div>

</div>
<div class="navfooter">
<span class="prev">
<a href="cat-plugins.html">« cat plugins API</a>
</span>
<span class="next">
<a href="cat-repositories.html">cat repositories API »</a>
</span>
</div>
</div>

                  <!-- end body -->
                        </div>
                        <div class="col-xs-12 col-sm-4 col-md-4" id="right_col">
                        
                        </div>
                    </div>
                </div>
            </section>
        </div>
    </section>
</div>
<script src="../static/cn.js"></script>
</body>
</html>